JBoss.orgCommunity Documentation
JBoss Communications SS7 Stack
provides Shell client to manage configuration of SS7 Stack Services. This chapter describes how to install and start client. Also it describes available
commands and provides examples.
To see examples of specific flow, to perform certain tasks, please refer to sections in chapter devoted to
SCCP
or
Linksets
.
Shell client can be started with following command from
$JBOSS_HOME/bin
:
[$] ./ss7-run.sh
Once console starts, it will print following information:
========================================================================= Mobicents SS7: release.version=1.0.0-SNAPSHOT This is free software, with components licensed under the GNU General Public License version 2 and other licenses. For further details visit http://mobicents.org ========================================================================= mobicents>
The
ss7-run
script supports following options
Usage: SS7 [OPTIONS] Valid Options -v Display version number and exit -h This help screen
Shell needs to connect to managed instance. Command to connect has following structure:
ss7 connect <IP> <PORT>
Example 5.1. Connec to remote machine
mobicents>ss7 connect 10.65.208.215 3435 mobicents(10.65.208.215:3435)>
Host IP and port are optional, if not specified, shell will try to connect to
127.0.0.1:3435
Command to disconnect has following structure:
ss7 discconnect
Linksets are managed by
linkset
command. It allows to perform following:
create linkset
delete linkset
activate linkset
deactivate linkset
create link
delete link
activate link
deactivate link
list state of linksets and present links
Linkset can be create by issuing command with following structure:
linkset create <linkset-type> opc <point-code> apc <point-code> ni <network-id> <linkset-name>
or in case of dialogic:
linkset create dialogic opc <point-code> apc <point-code> ni <network-id> srcmod <src-mode> destmod <dest-mode> <linkset-name>
Where:
refers to type of linkset to be created, ie.
dahdi
,
dialogic
or
m3ua
. Correct values depend on which linkset factories have been deployed.
is simply
MTP
point - either local(
opc
) or remote(
dpc
)
is simply network identifier. It can have following values:
International network
Spare (for international use only)
National network
Reserved for national use
simple string name, which identifies linkset
Example 5.3. Linkset creation
mobicents(10.65.208.215:3435)>linkset create dahdi opc 1 apc 2 ni 0 linkset1 LinkSet successfully added mobicents(10.65.208.215:3435)>linkset create dialogic opc 3 apc 4 ni 3 srcmod 1 destmod 2 linkset2 LinkSet successfully added
Linkset can be deleted by issuing command with following structure:
linkset delete <linkset-name>
Where:
is name set during link creation
Example 5.4. Linkset Removal
mobicents(10.65.208.215:3435)>linkset delete linkset1 LinkSet successfully deleted
Linkset can be activated by issuing command with following structure:
linkset activate <linkset-name>
Where:
is name set during link creation
Example 5.5. Linkset Activation
mobicents(10.65.208.215)>linkset activate linkset1 LinkSet activated successfully
Linkset can be deactivated by issuing command with following structure:
linkset deactivate <linkset-name>
Where:
is name set during link creation
Example 5.6. Linkset Deactivateion
mobicents(10.65.208.215)>linkset deactivate linkset1 LinkSet deactivated successfully
Link
can be created in
Linkset
by issuing command with following structure:
linkset link create span <span-num> code <code-num> channel <channel-num> <linkset-name> <link-name>
Where:
integer number. It represents port number in card(indexed from 0).
link code(sls assigned to this link).
integer number indicating time slot number(TDM time slot).
is name set during link creation.
name which identifies link in linkset.
Example 5.7.
mobicents(10.65.208.215:3435)>linkset link create span 1 code 1 channel 1 linkset1 link1 Link successfully added
Link
can be removed from in
Linkset
by issuing command with following structure:
linkset link delete <linkset-name> <link-name>
Where:
is name set during link creation
name which identifies link in linkset
Example 5.8. Link Removal
mobicents(10.65.208.215:3435)>linkset link delete linkset1 link1 Link successfully deleted
Link can be activated by issuing command with following structure:
linkset link activate <linkset-name> <link-name>
Where:
is name set during link creation
name which identifies link in linkset
Example 5.9. Link Activation
mobicents(10.65.208.215:3435)>linkset link activate linkset1 link1 Link activated successfully
Link can be deactivated by issuing command with following structure:
linkset link deactivate <linkset-name> <link-name>
Where:
is name set during link creation
name which identifies link in linkset
Example 5.10. Link Deactivateion
mobicents(10.65.208.215:3435)>linkset link deactivate linkset1 link1 Link deactivated successfully
Linkset and Link's status can be viewed by issuing command with following structure:
linkset show
Example 5.11. Linkset Status
mobicents(10.65.208.215:3435)>linkset show linkset1 dahdi opc=1 apc=2 ni=0 state=UNAVAILABLE link1 span=1 channelId=1 code=1 state=UNAVAILABLE
The possible state of Linkset are
UNAVAILABLE : Indicates the linkset does not have any “available” links and cannot transport traffic
SHUTDOWN : Indicates the linkset has been shutdown in the configuration
AVAILABLE : Indicates the linkset has at least one available link and can carry traffic
The possible state of Link are
UNAVAILABLE : Indicates the link is not available to carry traffic. This can occur if the link is remotely or locally inhibited by a user. It can also be unavailable if MTP2 has not been able to successfully activate the link connection.
SHUTDOWN : Indicates the link has been shutdown in the configuration.
AVAILABLE : Indicates the link is active and able to transport traffic
FAILED : A link is FAILED when the link is not shutdown but is unavailable at layer2 for some reason. For example Initial Alignment failed or the link test messages sent by MTP3 are not being acknowledged.